<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.18">
<title>Dear ImGui Bundle development doc</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<style>
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
/* Uncomment the following line when using as a custom stylesheet */
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
a{background:none}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
b,strong{font-weight:bold}
abbr{font-size:.9em}
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
dfn{font-style:italic}
hr{height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
audio,video{display:inline-block}
audio:not([controls]){display:none;height:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type=checkbox],input[type=radio]{padding:0}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,::before,::after{box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:0}
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.square{list-style-type:square}
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
table thead,table tfoot{background:#f7f8f7}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt{background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.center{margin-left:auto;margin-right:auto}
.stretch{width:100%}
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
.clearfix::after,.float-group::after{clear:both}
:not(pre).nobreak{word-wrap:normal}
:not(pre).nowrap{white-space:nowrap}
:not(pre).pre-wrap{white-space:pre-wrap}
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
pre>code{display:block}
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
em em{font-style:normal}
strong strong{font-weight:400}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menuref{color:#000}
.menuseq b:not(.caret),.menuref{font-weight:inherit}
.menuseq{word-spacing:-.02em}
.menuseq b.caret{font-size:1.25em;line-height:.8}
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
b.button::before{content:"[";padding:0 3px 0 2px}
b.button::after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
#content{margin-top:1.25em}
#content::before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span::before{content:"\00a0\2013\00a0"}
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber::after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
#content{margin-bottom:.625em}
.sect1{padding-bottom:.625em}
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
.sect1{padding-bottom:1.25em}}
.sect1:last-child{padding-bottom:0}
.sect1+.sect1{border-top:1px solid #e7e7e9}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
details{margin-left:1.25rem}
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
details>summary::-webkit-details-marker{display:none}
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
.listingblock>.content{position:relative}
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
.listingblock:hover code[data-lang]::before{display:block}
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.prettyprint{background:#f7f7f8}
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
pre.prettyprint li code[data-lang]::before{opacity:1}
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
table.linenotable td.code{padding-left:.75em}
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
.verseblock{margin:0 1em 1.25em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
p.tableblock:last-child{margin-bottom:0}
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all>*>tr>*{border-width:1px}
table.grid-cols>*>tr>*{border-width:0 1px}
table.grid-rows>*>tr>*{border-width:1px 0}
table.frame-all{border-width:1px}
table.frame-ends{border-width:1px 0}
table.frame-sides{border-width:0 1px}
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
ul.unstyled,ol.unstyled{margin-left:0}
li>p:empty:only-child::before{content:"";display:inline-block}
ul.checklist>li>p:first-child{margin-left:-1em}
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
ul.inline>li{margin-left:1.25em}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
td.hdlist2{word-wrap:anywhere}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
.colist td:not([class]):first-child img{max-width:none}
.colist td:not([class]):last-child{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
.imageblock.left{margin:.25em .625em 1.25em 0}
.imageblock.right{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background:#00fafa}
.black{color:#000}
.black-background{background:#000}
.blue{color:#0000bf}
.blue-background{background:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background:#fa00fa}
.gray{color:#606060}
.gray-background{background:#7d7d7d}
.green{color:#006000}
.green-background{background:#007d00}
.lime{color:#00bf00}
.lime-background{background:#00fa00}
.maroon{color:#600000}
.maroon-background{background:#7d0000}
.navy{color:#000060}
.navy-background{background:#00007d}
.olive{color:#606000}
.olive-background{background:#7d7d00}
.purple{color:#600060}
.purple-background{background:#7d007d}
.red{color:#bf0000}
.red-background{background:#fa0000}
.silver{color:#909090}
.silver-background{background:#bcbcbc}
.teal{color:#006060}
.teal-background{background:#007d7d}
.white{color:#bfbfbf}
.white-background{background:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background:#fafa00}
span.icon>.fa{cursor:default}
a span.icon>.fa{cursor:inherit}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]::after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,span.alt,summary{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@page{margin:1.25cm .75cm}
@media print{*{box-shadow:none!important;text-shadow:none!important}
html{font-size:80%}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]{border-bottom:1px dotted}
abbr[title]::after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#header,#content,#footnotes,#footer{max-width:none}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span::before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]::before{display:block}
#footer{padding:0 .9375em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
.sect1{padding:0!important}
.sect1+.sect1{border:0}
#footer{background:none}
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
</style>
<style>
pre.pygments .hll { background-color: #ffffcc }
pre.pygments { background: #f8f8f8; }
pre.pygments .tok-c { color: #3D7B7B; font-style: italic } /* Comment */
pre.pygments .tok-err { border: 1px solid #FF0000 } /* Error */
pre.pygments .tok-k { color: #008000; font-weight: bold } /* Keyword */
pre.pygments .tok-o { color: #666666 } /* Operator */
pre.pygments .tok-ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
pre.pygments .tok-cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
pre.pygments .tok-cp { color: #9C6500 } /* Comment.Preproc */
pre.pygments .tok-cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
pre.pygments .tok-c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
pre.pygments .tok-cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
pre.pygments .tok-gd { color: #A00000 } /* Generic.Deleted */
pre.pygments .tok-ge { font-style: italic } /* Generic.Emph */
pre.pygments .tok-gr { color: #E40000 } /* Generic.Error */
pre.pygments .tok-gh { color: #000080; font-weight: bold } /* Generic.Heading */
pre.pygments .tok-gi { color: #008400 } /* Generic.Inserted */
pre.pygments .tok-go { color: #717171 } /* Generic.Output */
pre.pygments .tok-gp { color: #000080; font-weight: bold } /* Generic.Prompt */
pre.pygments .tok-gs { font-weight: bold } /* Generic.Strong */
pre.pygments .tok-gu { color: #800080; font-weight: bold } /* Generic.Subheading */
pre.pygments .tok-gt { color: #0044DD } /* Generic.Traceback */
pre.pygments .tok-kc { color: #008000; font-weight: bold } /* Keyword.Constant */
pre.pygments .tok-kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
pre.pygments .tok-kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
pre.pygments .tok-kp { color: #008000 } /* Keyword.Pseudo */
pre.pygments .tok-kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
pre.pygments .tok-kt { color: #B00040 } /* Keyword.Type */
pre.pygments .tok-m { color: #666666 } /* Literal.Number */
pre.pygments .tok-s { color: #BA2121 } /* Literal.String */
pre.pygments .tok-na { color: #687822 } /* Name.Attribute */
pre.pygments .tok-nb { color: #008000 } /* Name.Builtin */
pre.pygments .tok-nc { color: #0000FF; font-weight: bold } /* Name.Class */
pre.pygments .tok-no { color: #880000 } /* Name.Constant */
pre.pygments .tok-nd { color: #AA22FF } /* Name.Decorator */
pre.pygments .tok-ni { color: #717171; font-weight: bold } /* Name.Entity */
pre.pygments .tok-ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
pre.pygments .tok-nf { color: #0000FF } /* Name.Function */
pre.pygments .tok-nl { color: #767600 } /* Name.Label */
pre.pygments .tok-nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
pre.pygments .tok-nt { color: #008000; font-weight: bold } /* Name.Tag */
pre.pygments .tok-nv { color: #19177C } /* Name.Variable */
pre.pygments .tok-ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
pre.pygments .tok-w { color: #bbbbbb } /* Text.Whitespace */
pre.pygments .tok-mb { color: #666666 } /* Literal.Number.Bin */
pre.pygments .tok-mf { color: #666666 } /* Literal.Number.Float */
pre.pygments .tok-mh { color: #666666 } /* Literal.Number.Hex */
pre.pygments .tok-mi { color: #666666 } /* Literal.Number.Integer */
pre.pygments .tok-mo { color: #666666 } /* Literal.Number.Oct */
pre.pygments .tok-sa { color: #BA2121 } /* Literal.String.Affix */
pre.pygments .tok-sb { color: #BA2121 } /* Literal.String.Backtick */
pre.pygments .tok-sc { color: #BA2121 } /* Literal.String.Char */
pre.pygments .tok-dl { color: #BA2121 } /* Literal.String.Delimiter */
pre.pygments .tok-sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
pre.pygments .tok-s2 { color: #BA2121 } /* Literal.String.Double */
pre.pygments .tok-se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
pre.pygments .tok-sh { color: #BA2121 } /* Literal.String.Heredoc */
pre.pygments .tok-si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
pre.pygments .tok-sx { color: #008000 } /* Literal.String.Other */
pre.pygments .tok-sr { color: #A45A77 } /* Literal.String.Regex */
pre.pygments .tok-s1 { color: #BA2121 } /* Literal.String.Single */
pre.pygments .tok-ss { color: #19177C } /* Literal.String.Symbol */
pre.pygments .tok-bp { color: #008000 } /* Name.Builtin.Pseudo */
pre.pygments .tok-fm { color: #0000FF } /* Name.Function.Magic */
pre.pygments .tok-vc { color: #19177C } /* Name.Variable.Class */
pre.pygments .tok-vg { color: #19177C } /* Name.Variable.Global */
pre.pygments .tok-vi { color: #19177C } /* Name.Variable.Instance */
pre.pygments .tok-vm { color: #19177C } /* Name.Variable.Magic */
pre.pygments .tok-il { color: #666666 } /* Literal.Number.Integer.Long */
</style>
<script data-goatcounter="https://pthom-imgui-bundle.goatcounter.com/count"
        async src="//gc.zgo.at/count.js"></script>
<style>.toc-current{font-weight: bold;} .toc-root{font-family: "Open Sans","DejaVu Sans",sans-serif;
                       font-size: 0.9em;} #content{display: flex; flex-direction: column; flex: 1 1 auto;}
             .nav-footer{text-align: center; margin-top: auto;}
             .nav-footer > p > a {white-space: nowrap;}</style>
</head>
<body id="bindings" class="article toc2 toc-left">
<div id="header">
<h1>Dear ImGui Bundle development doc</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<p><span class="toc-root"><a href="index.html">Dear ImGui Bundle development doc</a></span></p><ul class="sectlevel1">
<li><a href="bindings.html"><span class="toc-current">Python bindings: update &amp; adding new libraries</span></a>
<ul class="sectlevel2">
<li><a href="bindings.html#bindings_intro">Automated bindings: introduction</a>
</li>
<li><a href="bindings.html#bindings_newlib">Adding a new library to the bindings</a>
</li>
<li><a href="bindings.html#bindings_update">Update existing bindings</a>
</li>
<li><a href="bindings.html#_example_how_to_update_imgui_imgui_test_engine_and_their_python_bindings">Example: how to update imgui &amp; imgui test engine, and their python bindings</a>
</li>
</ul>
</li>
<li><a href="devdoc_emscripten.html">Developer notes / emscripten</a>
</li>
<li><a href="devdoc_winarm64.html">Developer note: Windows ARM64</a>
</li>
<li><a href="devdoc_pypi.html">Pypi bundle package distribution</a>
</li>
<li><a href="devdoc_pip.html">Python pip package build instructions</a>
</li>
</ul>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="bindings">Python bindings: update &amp; adding new libraries</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="bindings_intro">Automated bindings: introduction</h3>
<div class="paragraph">
<p>The bindings are generated automatically thanks to a sophisticated generator, which is based on <a href="https://www.srcml.org">srcML</a>.</p>
</div>
<div class="paragraph">
<p>The generator in provided by in <a href="https://pthom.github.io/litgen/litgen_book/00_00_intro.html">litgen</a> an automatic python bindings generator, developed by the same author as Dear ImGui Bundle.</p>
</div>
<div class="sect3">
<h4 id="_installing_the_generator">Installing the generator</h4>
<div class="paragraph">
<p>See the <a href="https://pthom.github.io/litgen/litgen_book/01_05_00_install_or_online.html#install-litgen-locally">installation instructions</a> (do a local installation).</p>
</div>
</div>
<div class="sect3">
<h4 id="_quick_information_about_the_generator">Quick information about the generator</h4>
<div class="paragraph">
<p><code>litgen</code> (aka "Literate Generator") is the package that will generate the python bindings.</p>
</div>
<div class="paragraph">
<p>Its source code is available <a href="https://github.com/pthom/litgen">here</a>.</p>
</div>
<div class="paragraph">
<p>It is heavily configurable by <a href="https://github.com/pthom/litgen/blob/main/src/litgen/options.py">a wide range of options</a>.</p>
</div>
<div class="paragraph">
<p>See for examples the <a href="https://github.com/pthom/imgui_bundle/blob/main/external/imgui/bindings/litgen_options_imgui.py">specific options for imgui bindings generation</a>.</p>
</div>
</div>
<div class="sect3">
<h4 id="_folders_structure">Folders structure</h4>
<div class="paragraph">
<p>In order to work on bindings, it is essential to understand the folders structure inside Dear ImGui Bundle.
Please study the <a href="https://pthom.github.io/imgui_bundle/folders.html">dedicated doc</a>.</p>
</div>
</div>
<div class="sect3">
<h4 id="_study_of_a_bound_library_generation">Study of a bound library generation</h4>
<div class="paragraph">
<p>Let&#8217;s take the example of the library ImCoolBar.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<div class="title">Tip</div>
</td>
<td class="content">
The processing of adding a new library from scratch is documented in <a href="bindings.html#bindings_newlib">Adding a new library to the bindings</a>. It uses ImCoolBar as an example
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Here is how the generation works for the library. The library principal files are located in external/ImCoolBar:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>external/ImCoolBar/<span class="tok-w">                        </span><span class="tok-c1"># Root folder for ImCoolBar</span>
├──<span class="tok-w"> </span>ImCoolBar/<span class="tok-w">                             </span><span class="tok-c1"># ImCoolBar submodule</span>
│<span class="tok-w">         </span>├──<span class="tok-w"> </span>CMakeLists.txt<span class="tok-w">               </span><span class="tok-c1"># ImCoolBar code</span>
│<span class="tok-w">         </span>├──<span class="tok-w"> </span>ImCoolbar.cpp
│<span class="tok-w">         </span>├──<span class="tok-w"> </span>ImCoolbar.h
│<span class="tok-w">         </span>├──<span class="tok-w"> </span>LICENSE
│<span class="tok-w">         </span>└──<span class="tok-w"> </span>README.md
└──<span class="tok-w"> </span>bindings/<span class="tok-w">                               </span><span class="tok-c1"># Scripts for the bindings generations &amp; bindings</span>
<span class="tok-w">    </span>├──<span class="tok-w"> </span>generate_imcoolbar.py<span class="tok-w">               </span><span class="tok-c1"># This script reads ImCoolbar.h and generates:</span>
<span class="tok-w">    </span><span class="tok-p">|</span><span class="tok-w">                                       </span><span class="tok-c1">#     - binding C++ code in ./pybind_imcoolbar.cpp</span>
<span class="tok-w">    </span><span class="tok-p">|</span><span class="tok-w">                                       </span><span class="tok-c1">#     - stubs in</span>
<span class="tok-w">    </span><span class="tok-p">|</span><span class="tok-w">                                       </span><span class="tok-c1">#          bindings/imgui_bundle/im_cool_bar_pyi</span>
<span class="tok-w">    </span>├──<span class="tok-w"> </span>im_cool_bar.pyi<span class="tok-w"> </span>-&gt;<span class="tok-w"> </span>../../../bindings/imgui_bundle/im_cool_bar.pyi<span class="tok-w">   </span><span class="tok-c1"># this is a symlink!</span>
<span class="tok-w">    </span>└──<span class="tok-w"> </span>pybind_imcoolbar.cpp</code></pre>
</div>
</div>
<div class="paragraph">
<p>The actual stubs are located here:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>imgui_bundle/bindings/imgui_bundle/
├──<span class="tok-w"> </span>im_cool_bar.pyi<span class="tok-w">              </span><span class="tok-c1"># Location of the stubs</span>
├──<span class="tok-w"> </span>__init__.pyi<span class="tok-w">                 </span><span class="tok-c1"># Main imgui_bundle stub file, which loads im_cool_bar.pyi</span>
├──<span class="tok-w"> </span>__init__.py<span class="tok-w">                  </span><span class="tok-c1"># Main imgui_bundle python module which loads</span>
<span class="tok-p">|</span><span class="tok-w">                                </span><span class="tok-c1"># the actual im_cool_bar module</span>
├──<span class="tok-w"> </span>...</code></pre>
</div>
</div>
<div class="paragraph">
<p>And the library is referenced in a global generation script:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>imgui_bundle/external/bindings_generation/
├──<span class="tok-w"> </span>autogenerate_all.py<span class="tok-w">          </span><span class="tok-c1"># This script will call generate_imcoolbar.py (among many others)</span>
├──<span class="tok-w"> </span>all_external_libraries.py<span class="tok-w">    </span><span class="tok-c1"># ImCoolBar is referenced here</span>
├──<span class="tok-w"> </span>...</code></pre>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="bindings_newlib">Adding a new library to the bindings</h3>
<div class="paragraph">
<p>This example is based on the addition of <a href="https://github.com/aiekick/ImCoolBar">ImCoolBar</a>, which was added in Oct 2023.</p>
</div>
<div class="sect3">
<h4 id="_step_1_reference_the_new_library">Step 1: Reference the new library</h4>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<div class="title">Tip</div>
</td>
<td class="content">
All the modifications done in step 1 can be seen in <a href="https://github.com/pthom/imgui_bundle/commit/68e6f3b3a5e812a1a3ddea275ad24296df5b7ce6">this commit</a>.
</td>
</tr>
</table>
</div>
<div class="sect4">
<h5 id="_step_1_a_add_needed_folders_files_and_submodules_inside_external">Step 1-a: Add needed folders, files and submodules inside external/</h5>
<div class="paragraph">
<p><strong>Add the library as a submodule in external/lib_name/lib_name</strong></p>
</div>
<div class="paragraph">
<p>If the library can be included without adaptations for inclusion inside ImGui Bundle, you can add it directly as a submodule.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>mkdir<span class="tok-w"> </span>external/ImCoolBar
git<span class="tok-w"> </span>submodule<span class="tok-w"> </span>add<span class="tok-w"> </span>https://github.com/aiekick/ImCoolBar.git<span class="tok-w"> </span>external/ImCoolBar/ImCoolBar</code></pre>
</div>
</div>
<div class="paragraph">
<p>However, if it requires adaptations, you need to create a fork (it was the case for ImCoolBar):
So, the following actions were done separately:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>ImCoolBar was cloned into github.com/pthom/ImCoolBar.git</p>
</li>
<li>
<p>a branch imgui_bundle was created and pushed to github. It will contain the adaptations and bug corrections for imgui_bundle.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Then, we add this fork as a submodule.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>git<span class="tok-w"> </span>submodule<span class="tok-w"> </span>add<span class="tok-w"> </span>https://github.com/pthom/ImCoolBar.git<span class="tok-w"> </span>external/ImCoolBar/ImCoolBar
<span class="tok-nb">cd</span><span class="tok-w"> </span>external/ImCoolBar/ImCoolBar
git<span class="tok-w"> </span>checkout<span class="tok-w"> </span>imgui_bundle
<span class="tok-nb">cd</span><span class="tok-w"> </span>-</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>Create the folder external/lib_name/bindings/</strong></p>
</div>
<div class="paragraph">
<p>Copy the folder <code>external/bindings_generation/bindings_generator_template</code> into <code>external/lib_name/bindings/</code></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>cp<span class="tok-w"> </span>-r<span class="tok-w"> </span>external/bindings_generation/bindings_generator_template<span class="tok-w"> </span>external/ImCoolBar/bindings</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>Rename files in external/lib_name/bindings</strong></p>
</div>
<div class="paragraph">
<p>After having copied the template files, we need to rename them.
In the example of ImCoolbar, we will rename them as follows:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-w"> </span>mv<span class="tok-w"> </span>external/ImCoolBar/bindings/generate_LIBNAME.py<span class="tok-w"> </span>external/ImCoolBar/bindings/generate_imcoolbar.py
mv<span class="tok-w"> </span>external/ImCoolBar/bindings/pybind_LIBNAME.cpp<span class="tok-w"> </span>external/ImCoolBar/bindings/pybind_imcoolbar.cpp
<span class="tok-c1"># im_cool_bar will be the final name of the python module: imgui_bundle.im_cool_bar</span>
mv<span class="tok-w"> </span>external/ImCoolBar/bindings/LIBNAME.pyi<span class="tok-w"> </span>external/ImCoolBar/bindings/im_cool_bar.pyi</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>Move external/ImCoolBar/bindings/im_cool_bar.pyi to bindings/imgui_bundle/</strong></p>
</div>
<div class="paragraph">
<p>The stub file (*.pyi) <em>must</em> be inside bindings/imgui_bundle. In order to facilitate development, we will create a symlink to it inside external/ImCoolBar/bindings/</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>mv<span class="tok-w"> </span>external/ImCoolBar/bindings/im_cool_bar.pyi<span class="tok-w"> </span>bindings/imgui_bundle/im_cool_bar.pyi
<span class="tok-nb">cd</span><span class="tok-w"> </span>external/ImCoolBar/bindings/
ln<span class="tok-w"> </span>-s<span class="tok-w"> </span>../../../bindings/imgui_bundle/im_cool_bar.pyi<span class="tok-w"> </span>.
<span class="tok-nb">cd</span><span class="tok-w"> </span>-</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>Final folder structure</strong></p>
</div>
<div class="paragraph">
<p>We end up with the following structure:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>external/ImCoolBar/
├──<span class="tok-w"> </span>ImCoolBar/<span class="tok-w">                   </span><span class="tok-c1"># Note that the submodule is inside</span>
│<span class="tok-w">         </span>├──<span class="tok-w"> </span>CMakeLists.txt<span class="tok-w">     </span><span class="tok-c1"># external/ImCoolBar/ImCoolBar/ !!!</span>
│<span class="tok-w">         </span>├──<span class="tok-w"> </span>ImCoolbar.cpp
│<span class="tok-w">         </span>├──<span class="tok-w"> </span>ImCoolbar.h
│<span class="tok-w">         </span>├──<span class="tok-w"> </span>LICENSE
│<span class="tok-w">         </span>└──<span class="tok-w"> </span>README.md
└──<span class="tok-w"> </span>bindings/
<span class="tok-w">    </span>├──<span class="tok-w"> </span>im_cool_bar.pyi<span class="tok-w">              </span><span class="tok-c1"># We will edit and rename those files later</span>
<span class="tok-w">    </span>├──<span class="tok-w"> </span>generate_imcoolbar.py<span class="tok-w"> </span>-&gt;<span class="tok-w"> </span>symlink<span class="tok-w"> </span>to<span class="tok-w"> </span>../../../bindings/imgui_bundle/im_cool_bar.pyi
<span class="tok-w">    </span>└──<span class="tok-w"> </span>pybind_imcoolbar.cpp</code></pre>
</div>
</div>
<hr>
</div>
<div class="sect4">
<h5 id="_step_1_b_update_python_generator_manager">Step 1-b:  Update python generator manager</h5>
<div class="paragraph">
<p><strong>Update external/bindings_generation/all_external_libraries.py</strong></p>
</div>
<div class="paragraph">
<p>Add a function that returns info about this new library:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-k">def</span> <span class="tok-nf">lib_imcoolbar</span><span class="tok-p">()</span> <span class="tok-o">-&gt;</span> <span class="tok-n">ExternalLibrary</span><span class="tok-p">:</span>
    <span class="tok-k">return</span> <span class="tok-n">ExternalLibrary</span><span class="tok-p">(</span>
        <span class="tok-n">name</span><span class="tok-o">=</span><span class="tok-s2">&quot;ImCoolBar&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">official_git_url</span><span class="tok-o">=</span><span class="tok-s2">&quot;https://github.com/aiekick/ImCoolBar.git&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">official_branch</span><span class="tok-o">=</span><span class="tok-s2">&quot;master&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">fork_git_url</span><span class="tok-o">=</span><span class="tok-s2">&quot;https://github.com/pthom/ImCoolBar.git&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">fork_branch</span><span class="tok-o">=</span><span class="tok-s2">&quot;imgui_bundle&quot;</span>
    <span class="tok-p">)</span></code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-n">ALL_LIBS</span> <span class="tok-o">=</span> <span class="tok-p">[</span>
    <span class="tok-n">lib_imgui</span><span class="tok-p">(),</span>  <span class="tok-c1"># must be first as it declare bindings used by the next ones</span>
    <span class="tok-c1"># ...</span>
    <span class="tok-n">lib_imcoolbar</span><span class="tok-p">(),</span>  <span class="tok-c1"># Add the lib here</span>
    <span class="tok-c1"># ...</span></code></pre>
</div>
</div>
</div>
<div class="sect4">
<h5 id="_step_1_c_update_the_c_sources_to_include_the_new_lib_binding_generation">Step 1-c:  Update the C++ sources to include the new lib binding generation</h5>
<div class="paragraph">
<p><strong>In external/CMakeLists.txt:</strong>
Add a cmake directive to compile the new library.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="cmake"><span></span><span class="tok-c"># If the library is &quot;simple&quot; to compile you can use `add_simple_external_library_with_sources`</span>
<span class="tok-nb">add_simple_external_library_with_sources</span><span class="tok-p">(</span><span class="tok-s">imcoolbar</span><span class="tok-w"> </span><span class="tok-s">ImCoolBar</span><span class="tok-p">)</span></code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>In external/bindings_generation/cpp/all_pybind_files.cmake:</strong></p>
</div>
<div class="paragraph">
<p>add <code>external/ImCoolBar/bindings/pybind_imcoolbar.cpp</code></p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
the script external/bindings_generation/autogenerate_all.py will also regenerate this file from scratch.
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><strong>In external/bindings_generation/cpp/pybind_imgui_bundle.cpp:</strong></p>
</div>
<div class="paragraph">
<p>Add the bindings</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="cpp"><span></span><span class="tok-c1">// ... Near the start of the file, add a new function declaration</span>
<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-nf">py_init_module_imgui_command_palette</span><span class="tok-p">(</span><span class="tok-n">py</span><span class="tok-o">::</span><span class="tok-k">module</span><span class="tok-o">&amp;</span><span class="tok-w"> </span><span class="tok-n">m</span><span class="tok-p">);</span>
<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-nf">py_init_module_implot_internal</span><span class="tok-p">(</span><span class="tok-n">py</span><span class="tok-o">::</span><span class="tok-k">module</span><span class="tok-o">&amp;</span><span class="tok-w"> </span><span class="tok-n">m</span><span class="tok-p">);</span>
<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-nf">py_init_module_imcoolbar</span><span class="tok-p">(</span><span class="tok-n">py</span><span class="tok-o">::</span><span class="tok-k">module</span><span class="tok-o">&amp;</span><span class="tok-w"> </span><span class="tok-n">m</span><span class="tok-p">);</span><span class="tok-w">         </span><span class="tok-c1">// added this line</span>
<span class="tok-c1">//  ...</span>


<span class="tok-kt">void</span><span class="tok-w"> </span><span class="tok-nf">py_init_module_imgui_bundle</span><span class="tok-p">(</span><span class="tok-n">py</span><span class="tok-o">::</span><span class="tok-k">module</span><span class="tok-o">&amp;</span><span class="tok-w"> </span><span class="tok-n">m</span><span class="tok-p">)</span>
<span class="tok-p">{</span>
<span class="tok-w">    </span><span class="tok-c1">// ...</span>

<span class="tok-w">    </span><span class="tok-c1">// At the end of py_init_module_imgui_bundle, register your new python module</span>
<span class="tok-w">    </span><span class="tok-k">auto</span><span class="tok-w"> </span><span class="tok-n">module_imcooolbar</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-n">m</span><span class="tok-p">.</span><span class="tok-n">def_submodule</span><span class="tok-p">(</span><span class="tok-s">&quot;im_cool_bar&quot;</span><span class="tok-p">);</span><span class="tok-w"> </span><span class="tok-c1">// the python module will be known as imgui_bundle.im_cool_bar</span>
<span class="tok-w">    </span><span class="tok-n">py_init_module_imcoolbar</span><span class="tok-p">(</span><span class="tok-n">module_imcooolbar</span><span class="tok-p">);</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Now, run cmake.</p>
</div>
</div>
<div class="sect4">
<h5 id="_step_1_d_edit_and_adapt_the_generation_scripts">Step 1-d: Edit and adapt the generation scripts</h5>
<div class="paragraph">
<p>Edit the 3 files inside <code>external/ImCoolBar/bindings</code> and replace occurrences of LIBNAME with appropriate values.</p>
</div>
</div>
<div class="sect4">
<h5 id="_step_1_e_edit_and_adapt_the_imgui_bundle_init_scripts">Step 1-e: Edit and adapt the imgui_bundle <em>init</em> scripts</h5>
<div class="paragraph">
<p>In bindings/imgui_bundle/<em>init</em>.py, this line was added:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-kn">from</span> <span class="tok-nn">imgui_bundle._imgui_bundle</span> <span class="tok-kn">import</span> <span class="tok-n">im_cool_bar</span> <span class="tok-k">as</span> <span class="tok-n">im_cool_bar</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>In bindings/imgui_bundle/<em>init</em>.pyi, this line was added:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-kn">from</span> <span class="tok-nn">.</span> <span class="tok-kn">import</span> <span class="tok-n">im_cool_bar</span> <span class="tok-k">as</span> <span class="tok-n">im_cool_bar</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_step_2_fine_tune_the_generation_options_and_write_a_demo">Step 2: fine tune the generation options and write a demo</h4>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<div class="title">Tip</div>
</td>
<td class="content">
All the modifications done in step 2 can be seen in <a href="https://github.com/pthom/imgui_bundle/commit/25e6ef43c1aa8c83c8a7286cd7491b296b58de00">this commit</a>.
</td>
</tr>
</table>
</div>
<div class="sect4">
<h5 id="_step_2_a_edit_and_run_externalimcoolbarbindingsgenerate_imcoolbar_py">Step 2-a: Edit and run <code>external/ImCoolBar/bindings/generate_imcoolbar.py</code>:</h5>
<div class="paragraph">
<p>Edit and re-run it until the generated code fits the expected needs.</p>
</div>
<div class="paragraph">
<p>In the case of ImCoolBar, two simple changes were made:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-k">def</span> <span class="tok-nf">main</span><span class="tok-p">():</span>
    <span class="tok-c1"># ...</span>
    <span class="tok-c1"># ...</span>

    <span class="tok-c1"># Configure options</span>
    <span class="tok-n">options</span> <span class="tok-o">=</span> <span class="tok-n">litgen</span><span class="tok-o">.</span><span class="tok-n">LitgenOptions</span><span class="tok-p">()</span>
    <span class="tok-n">options</span><span class="tok-o">.</span><span class="tok-n">namespaces_root</span> <span class="tok-o">=</span> <span class="tok-p">[</span><span class="tok-s2">&quot;ImGui&quot;</span><span class="tok-p">]</span>
    <span class="tok-n">options</span><span class="tok-o">.</span><span class="tok-n">srcmlcpp_options</span><span class="tok-o">.</span><span class="tok-n">functions_api_prefixes</span> <span class="tok-o">=</span> <span class="tok-s2">&quot;IMGUI_API&quot;</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>Each time you run the code generation, look at <code>external/ImCoolBar/bindings/im_cool_bar.pyi</code> and <code>external/ImCoolBar/bindings/pybind_imcoolbar.cpp</code> to see if they seem OK. Also run a compilation.</p>
</div>
</div>
<div class="sect4">
<h5 id="_step_2_b_fix_syntax_issues_in_externalimcoolbarbindingsim_cool_bar_pyi">Step 2-b: Fix syntax issues in  <code>external/ImCoolBar/bindings/im_cool_bar.pyi</code>:</h5>
<div class="paragraph">
<p>You can add some code before the autogenerated code to fix the syntax issues.
For example, this was added:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span>
<span class="tok-kn">import</span> <span class="tok-nn">enum</span>

<span class="tok-kn">from</span> <span class="tok-nn">imgui_bundle.imgui</span> <span class="tok-kn">import</span> <span class="tok-n">ImVec2</span><span class="tok-p">,</span> <span class="tok-n">WindowFlags</span><span class="tok-p">,</span> <span class="tok-n">WindowFlags_</span>
<span class="tok-n">ImCoolBarFlags</span> <span class="tok-o">=</span> <span class="tok-nb">int</span>
<span class="tok-n">ImGuiWindowFlags</span> <span class="tok-o">=</span> <span class="tok-n">WindowFlags</span>
<span class="tok-n">ImGuiWindowFlags_None</span> <span class="tok-o">=</span> <span class="tok-n">WindowFlags_</span><span class="tok-o">.</span><span class="tok-n">none</span>


<span class="tok-c1"># !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!  AUTOGENERATED CODE !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!</span>
<span class="tok-c1"># &lt;litgen_stub&gt; // Autogenerated code below! Do not edit!</span>
<span class="tok-c1">####################    &lt;generated_from:ImCoolbar.h&gt;    ####################</span></code></pre>
</div>
</div>
</div>
<div class="sect4">
<h5 id="_step_2_c_write_a_nice_looking_demo">Step 2-c: Write a nice looking demo</h5>
<div class="paragraph">
<p>It should demo the library, and act as a tutorial, in python and C++.</p>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="bindings_update">Update existing bindings</h3>
<div class="paragraph">
<p>The process for updating bindings for a given library is straightforward:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Update the library submodule in external/LIBNAME/LIBNAME</p>
</li>
<li>
<p>Run the generation script in external/LIBNAME/generate_LIBNAME.py</p>
</li>
<li>
<p>Compile and test python bindings
(carefully study that nothing was broken)</p>
</li>
<li>
<p>Commit and push</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>For example with ImCoolBar, in order to update the bindings for ImCoolBar, one needs to run:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span>python<span class="tok-w"> </span>external/ImCoolBar/bindings/generate_imcoolbar.py</code></pre>
</div>
</div>
<div class="paragraph">
<p>(See <a href="bindings.html#bindings_intro">Automated bindings: introduction</a>)</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<div class="title">Tip</div>
</td>
<td class="content">
This <a href="https://youtu.be/QeBCxU7tn68">video</a> demonstrates from starts to finish the process of updating imgui and its bindings (17 minutes).
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_example_how_to_update_imgui_imgui_test_engine_and_their_python_bindings">Example: how to update imgui &amp; imgui test engine, and their python bindings</h3>
<div class="sect3">
<h4 id="_intro_submodules_maintenance">Intro: submodules maintenance</h4>
<div class="paragraph">
<p><a href="https://github.com/pthom/imgui_bundle/tree/main/external/bindings_generation">external/bindings_generation</a> contains some scripts for  the submodules maintenance.</p>
</div>
<div class="paragraph">
<p>See this extract of <a href="https://github.com/pthom/imgui_bundle/tree/main/external/bindings_generation/all_external_libraries.py">external/bindings_generation/all_external_libraries.py</a>, which shows that imgui and imgui_test_engine are using forks.</p>
</div>
<div class="paragraph">
<p>These forks include small modifications added for compatibility with imgui_bundle (most modifications are small changes to accommodate with python bindings).</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-k">def</span> <span class="tok-nf">lib_imgui</span><span class="tok-p">()</span> <span class="tok-o">-&gt;</span> <span class="tok-n">ExternalLibrary</span><span class="tok-p">:</span>
    <span class="tok-k">return</span> <span class="tok-n">ExternalLibrary</span><span class="tok-p">(</span>
        <span class="tok-n">name</span><span class="tok-o">=</span><span class="tok-s2">&quot;imgui&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">official_git_url</span><span class="tok-o">=</span><span class="tok-s2">&quot;https://github.com/ocornut/imgui.git&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">official_branch</span><span class="tok-o">=</span><span class="tok-s2">&quot;docking&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">fork_git_url</span><span class="tok-o">=</span><span class="tok-s2">&quot;https://github.com/pthom/imgui.git&quot;</span>
    <span class="tok-p">)</span>


<span class="tok-k">def</span> <span class="tok-nf">lib_imgui_test_engine</span><span class="tok-p">()</span> <span class="tok-o">-&gt;</span> <span class="tok-n">ExternalLibrary</span><span class="tok-p">:</span>
    <span class="tok-k">return</span> <span class="tok-n">ExternalLibrary</span><span class="tok-p">(</span>
        <span class="tok-n">name</span><span class="tok-o">=</span><span class="tok-s2">&quot;imgui_test_engine&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">official_git_url</span><span class="tok-o">=</span><span class="tok-s2">&quot;https://github.com/ocornut/imgui_test_engine.git&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">official_branch</span><span class="tok-o">=</span><span class="tok-s2">&quot;main&quot;</span><span class="tok-p">,</span>
        <span class="tok-n">fork_git_url</span><span class="tok-o">=</span><span class="tok-s2">&quot;https://github.com/pthom/imgui_test_engine.git&quot;</span><span class="tok-p">,</span>
    <span class="tok-p">)</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>When using forked libraries, the git remote name for the fork is "fork", and the remote name for the official repository is "official".</p>
</div>
<div class="paragraph">
<p><strong>Reattach all submodules to their upstream branch</strong></p>
</div>
<div class="paragraph">
<p>By default, all submodules, are in mode "detached head". We need to attach them to the correct remote/branch.</p>
</div>
<div class="paragraph">
<p>We can use the utilities from external/bindings_generation:</p>
</div>
<div class="paragraph">
<p>For example, <a href="https://github.com/pthom/imgui_bundle/tree/main/external/bindings_generation/sandbox.py">external/bindings_generation/sandbox.py</a> contains this:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-kn">from</span> <span class="tok-nn">bindings_generation</span> <span class="tok-kn">import</span> <span class="tok-n">all_external_libraries</span>

<span class="tok-n">all_external_libraries</span><span class="tok-o">.</span><span class="tok-n">reattach_all_submodules</span><span class="tok-p">()</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>It will reattach all submodules to the correct remote/branch.</p>
</div>
</div>
<div class="sect3">
<h4 id="_update_imgui_and_imgui_test_engine">Update imgui and imgui_test_engine</h4>
<div class="paragraph">
<p><strong>First, add a tag to our forks</strong></p>
</div>
<div class="paragraph">
<p>Since we will be updating our imgui and imgui_test_engine forks via a rebase, we should push a tag, so that old versions remain accessible on GitHub.</p>
</div>
<div class="paragraph">
<p>In this example, the current version of imgui_bundle is v1.0.0-beta1. So we push a "bundle_1.0.0-beta1" tag to the forks.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">cd</span><span class="tok-w"> </span>external/imgui/imgui
git<span class="tok-w"> </span>tag<span class="tok-w"> </span><span class="tok-s2">&quot;bundle_1.0.0-beta1&quot;</span>
git<span class="tok-w"> </span>push<span class="tok-w"> </span>fork<span class="tok-w"> </span>--tags
<span class="tok-nb">cd</span><span class="tok-w"> </span>-

<span class="tok-nb">cd</span><span class="tok-w"> </span>external/imgui_test_engine/imgui_test_engine
git<span class="tok-w"> </span>tag<span class="tok-w"> </span><span class="tok-s2">&quot;bundle_1.0.0-beta1&quot;</span>
git<span class="tok-w"> </span>push<span class="tok-w"> </span>fork<span class="tok-w"> </span>--tags
<span class="tok-nb">cd</span><span class="tok-w"> </span>-</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>Then rebase our forks on the official branch changes</strong></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">cd</span><span class="tok-w"> </span>external/imgui/imgui
git<span class="tok-w"> </span>rebase<span class="tok-w"> </span>official/docking
<span class="tok-nb">cd</span><span class="tok-w"> </span>-</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="bash"><span></span><span class="tok-nb">cd</span><span class="tok-w"> </span>external/imgui_test_engine/imgui_test_engine
git<span class="tok-w"> </span>rebase<span class="tok-w"> </span>official/main
<span class="tok-nb">cd</span><span class="tok-w"> </span>-</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_run_generate_imgui_py">Run generate_imgui.py</h4>
<div class="paragraph">
<p><strong>Run generate_imgui</strong></p>
</div>
<div class="paragraph">
<p>We will run <a href="https://github.com/pthom/imgui_bundle/tree/main/external/imgui/bindings/generate_imgui.py">external/imgui/bindings/generate_imgui.py</a>.</p>
</div>
<div class="paragraph">
<p>It will generate the python bindings for imgui, imgui_internal and imgui_test_engine.</p>
</div>
<div class="paragraph">
<p>See main() function of generate_imgui.py:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="python"><span></span><span class="tok-k">def</span> <span class="tok-nf">main</span><span class="tok-p">():</span>
    <span class="tok-n">autogenerate_imgui</span><span class="tok-p">()</span>
    <span class="tok-n">autogenerate_imgui_internal</span><span class="tok-p">()</span>
    <span class="tok-n">autogenerate_imgui_test_engine</span><span class="tok-p">()</span></code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>Examine the changes</strong>
Look at the changes, and check if they look ok</p>
</div>
</div>
<div class="sect3">
<h4 id="_compile_test">Compile &amp; Test</h4>
<div class="paragraph">
<p><strong>Correct possible compilation errors due to breaking changes in imgui&#8217;s API</strong></p>
</div>
<div class="paragraph">
<p><strong>Test in C++</strong></p>
</div>
<div class="paragraph">
<p>Run <code>demo_imgui_bundle</code></p>
</div>
<div class="paragraph">
<p>(demo_imgui_bundle is a global demonstration program, that uses most of the feature of all libraries)</p>
</div>
<div class="paragraph">
<p><strong>Test in Python</strong></p>
</div>
<div class="paragraph">
<p>Run <code>demo_imgui_bundle.py</code></p>
</div>
</div>
<div class="sect3">
<h4 id="_update_forked_submodules">Update forked submodules:</h4>
<div class="paragraph">
<p>if some forked submodules required to be changed:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>tag them, push the tag</p>
</li>
<li>
<p>rebase the fork branch on the official branch</p>
</li>
<li>
<p>push the changes</p>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="paragraph nav-footer">
<p>↑ Up: <a href="index.html">Dear ImGui Bundle development doc</a> | Next: <a href="devdoc_emscripten.html">Developer notes / emscripten</a> →</p>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-11-30 11:43:32 +0100
</div>
</div>
</body>
</html>